home *** CD-ROM | disk | FTP | other *** search
/ New Star Software Collection / NSS_Collection.iso / 5-029 turbo debugger and assem / disks.7z / 1 / README < prev    next >
Encoding:
Text File  |  1988-08-28  |  14.5 KB  |  382 lines
  1.                   WELCOME TO TURBO DEBUGGER 1.0
  2.                   -----------------------------
  3.  
  4. This README file contains important, last minute information
  5. about Turbo Debugger 1.0. The HELPME!.DOC file on the TURBO
  6. DEBUGGER/INSTALLATION disk also answers many common Technical
  7. Support questions.
  8.  
  9.  
  10. TABLE OF CONTENTS
  11. -----------------
  12.  
  13.   1.  How to get Help
  14.   2.  Installation
  15.   3.  Important Additions
  16.   4.  Notes and Restrictions
  17.   5.  Manual Additions and Corrections
  18.   6.  Files on the Disks
  19.  
  20.  
  21. 1. HOW TO GET HELP
  22. ------------------
  23.  
  24.   If you have any problems, please read this file, the
  25.   HELPME!.DOC file, and the Turbo Debugger manual first. If you
  26.   still have a question and need assistance, help is available
  27.   from the following sources:
  28.  
  29.   1. Type GO BOR on the CompuServe bulletin board system for
  30.      instant access to the Borland forums with their libraries of
  31.      technical information and answers to common questions.
  32.  
  33.      If you are not a member of CompuServe, see the enclosed special
  34.      offer, and write for full details on how to receive a free
  35.      IntroPak containing a $15 credit toward your first month's on-
  36.      line charges.
  37.  
  38.   2. Check with your local software dealer or users' group.
  39.  
  40.   3. Write to us at the following address:
  41.  
  42.      Borland International
  43.      Turbo Debugger Technical Support
  44.      1800 Green Hills Road
  45.      P.O. Box 660001
  46.      Scotts Valley, CA  95066-0001
  47.  
  48.      Please remember to include your serial number or we will be
  49.      unable to process your letter.
  50.  
  51.   4. If you have an urgent problem that cannot wait and you have sent
  52.      in the license agreement from the front of your manual, you may
  53.      call the Borland Technical Support Department at (408) 438-5300.
  54.      Please have the following information ready before calling:
  55.  
  56.      a. Product name and serial number on your original distribution
  57.         disk.  Please have your serial number ready or we will be
  58.         unable to process your call.
  59.  
  60.      b. Product version number. The version number for Turbo
  61.         Debugger is displayed when you first load the program and
  62.         before you press any keys.
  63.  
  64.      c. Computer brand, model, and the brands and model numbers of
  65.         any additional hardware.
  66.  
  67.      d. Operating system and version number. (The version number can
  68.         be determined by typing VER at the MSDOS prompt.)
  69.  
  70.      e. Contents of your AUTOEXEC.BAT file.
  71.  
  72.      f. Contents of your CONFIG.SYS file.
  73.  
  74. 2. INSTALLATION
  75. ---------------
  76.  
  77. This disk contains a program called INSTALL.EXE that will assist
  78. you with the installation of Turbo Debugger 1.0. There are three
  79. options for installation:
  80.  
  81.   1. Hard Disk - INSTALL will copy all Turbo Debugger files onto
  82.      your hard disk and put them into subdirectories. The default
  83.      subdirectories are
  84.  
  85.        Turbo Debugger Directory:                    C:\TD
  86.        Example Subdirectory:                        C:\TD
  87.  
  88.      By default, all files from the distribution disks are placed
  89.      in the Turbo Debugger Directory. If you would rather
  90.      separate the examples programs into their own subdirectory
  91.      as well, edit the default example files path before
  92.      selecting START INSTALLATION.
  93.  
  94.   2. Floppy Disk - This option will build a working Turbo
  95.      Debugger 4-disk set that will work on a two drive system. Be
  96.      sure to have four formatted disks ready before you start.
  97.      Install will build
  98.  
  99.        Program Disk - Turbo Debugger main program, Readme file,
  100.        Turbo Debugger customization program, Helpme file and
  101.        Manual file.
  102.  
  103.        Work Disk - Turbo Debugger working overlay file and help
  104.        file.
  105.  
  106.        Utilities Disk - Turbo Debugger utilities.
  107.  
  108.        Examples Disk - Example programs for use with Turbo
  109.        Debugger.
  110.  
  111. To start the installation, change your current drive to the one
  112. that has the install program on it and type INSTALL. You will be
  113. given instructions in a box at the bottom of the screen for each
  114. prompt. For example, if you will be installing from drive A:, you
  115. would type
  116.  
  117.   A:
  118.   INSTALL
  119.  
  120. You should read the rest of this README file to get further
  121. information about this release before you do the installation.
  122.  
  123. The Turbo Debugger UTILITIES/EXAMPLES distribution disk contains
  124. several files with an .ARC file extension: TDEXAMPL.ARC,
  125. TAEXAMPL1.ARC, and TAEXAMPL2.ARC. These files contain several
  126. other files that have been compressed and placed inside an
  127. archive. You can dearchive them yourself by using the UNPACK.COM
  128. utility.
  129.  
  130. For example,
  131.  
  132.   unpack tdexampl
  133.  
  134. unpacks all the files stored in the TDEXAMPL.ARC archive into the
  135. current directory.
  136.  
  137. INSTALL gives you a choice of copying the .ARC files intact or
  138. dearchiving and copying all of the individual files onto your
  139. hard disk during the installation process. Note that INSTALL does
  140. not unpack the TAEXAMPL1.ARC, TAEXAMPL2.ARC, or CHAPXMPL.ARC files
  141. from the UTILITIES/EXAMPLES disk. These files contain example
  142. programs for the TURBO ASSEMBLER.
  143.  
  144. If you have difficulty reading the text displayed by the INSTALL
  145. program, it accepts an optional command-line parameter that forces
  146. it to use black and white colors:
  147.  
  148.   a:install /B      - Forces INSTALL into BW80 mode
  149.  
  150. Specifying the /B parameter may be necessary if you are using an
  151. LCD screen or a system that has a color graphics adapter and a
  152. monochrome or composite monitor.
  153.  
  154.  
  155. 3. IMPORTANT ADDITIONS
  156. ----------------------
  157.  
  158.   3.1 Changes to the command-line options for TD
  159.   ----------------------------------------------
  160.  
  161.   -h   a list of all the command-line options available for TD.EXE
  162.  
  163.   -c   lets you specify a configuration file that will be loaded at
  164.        startup. By default, Turbo Debugger uses the configuration
  165.        file TDCONFIG.TD (if found); if you give the -c<file> option,
  166.        Turbo Debugger will use that file instead.
  167.  
  168.        You must supply a configuration file name after the -c,
  169.        with no space between the -c and the file name, for
  170.        example,
  171.  
  172.          TD -cmyconfig myprog
  173.  
  174.        If you don't supply an extension to the file name, Turbo
  175.        Debugger adds the .TD extension.
  176.  
  177.   -m   If you specify a heap size of 0 with the -m command-line
  178.        option (-m0), Turbo Debugger will use the maximum that it's
  179.        able to use, 64K. Specifying a value larger than 64K may
  180.        cause unexpected results.
  181.  
  182.   -vp  Enable EGA palette save.
  183.  
  184.        This new command-line option controls palette swapping on
  185.        EGA video adapters. It is only recommended when the user
  186.        program modifies the EGA palette registers. When -vp is
  187.        specified, the EGA palette is restored each time the
  188.        screen is swapped. In general, you don't need to use this
  189.        option unless your program modifies the EGA palette
  190.        registers, or unless your program uses BGI to change the
  191.        palette.
  192.  
  193.  
  194.   3.2 Changes to the command-line options for TD utilities
  195.   --------------------------------------------------------
  196.  
  197.   For a list of all the command-line options available for
  198.   TDINST.EXE, TDREMOTE.EXE, INSTALL.EXE, and TDNMI.COM, enter
  199.   the program name followed by -h:
  200.  
  201.     <program name> -h.
  202.  
  203.   For a list of all the command-line options available for
  204.   TDMAP.EXE, TDPACK.EXE, TDRF.EXE, TDSTRIP.EXE, TDCONVRT.EXE,
  205.   TD386.EXE and TDUMP.EXE, just type the program name:
  206.  
  207.     <program name>
  208.  
  209.   Note: If you have an 80386-based machine and want to read the
  210.   command-line options for TD386.EXE, TDH386.SYS must be loaded.
  211.  
  212.  
  213.   3.3  TD.OVL
  214.   -----------
  215.  
  216.   Turbo Debugger consists of an executable program, TD.EXE, and
  217.   an overlay file, TD.OVL. Both files are required.  On a hard
  218.   disk system, they should be put in the same directory.
  219.  
  220.   If you are running on a two-floppy system, you should put the
  221.   overlay file (TD.OVL) and the help file (TDHELP.TDH) on one
  222.   diskette and TD.EXE on another diskette. To start Turbo
  223.   Debugger, you insert the disk containing TD.EXE and type "TD"
  224.   on the command line. You will then be prompted to insert the
  225.   diskette containing the overlay file.
  226.  
  227.   Once you have inserted the overlay diskette, don't remove it
  228.   for the remainder of your debugging session.
  229.  
  230.  
  231.   3.4  TDNMI.COM UTILITY
  232.   ----------------------
  233.  
  234.   If you are using a breakout switch on a PC clone that disables
  235.   the NMI interrupt (such as some PC's Limited systems), you will
  236.   need to install the TDNMI resident utility to clear the NMI every
  237.   half second.
  238.  
  239.   Use TDNMI with the /p option if you have a Periscope I board
  240.   and wish to use its breakout switch with Turbo Debugger. TDNMI
  241.   will then periodically reset the breakout-switch latch on the
  242.   Periscope board.  Use the /p command-line option followed by a
  243.   hex address to set the board's base address if it is different
  244.   from the default address of 300.
  245.  
  246.  
  247.   3.5 Additions to hardware device driver interface
  248.   -------------------------------------------------
  249.  
  250.   o The "Get Hardware Capabilities" status block returned by the
  251.     device driver has an additional field that it returns after
  252.     the "Maximum data match length field." This field is 2 bytes
  253.     long and specifies the segment address where Turbo Debugger
  254.     must write a byte with a value of 1 to enable hardware
  255.     breakpoints. The field must contain 0 if the device driver
  256.     does not or cannot support this capability. If supported,
  257.     this byte allows Turbo Debugger to inform the device driver
  258.     that it has finished writing things to the address space of
  259.     the program being debugged, and that subsequent accesses can
  260.     cause hardware breakpoints.
  261.  
  262.   o The special value FE (hex) can be returned by the hardware
  263.     device driver if it has been recursively entered while
  264.     processing a hardware breakpoint. This can happen if a
  265.     hardware breakpoint has been set in the 6 bytes below the
  266.     current top of stack in the program being debugged. If Turbo
  267.     Debugger receives this entry code, it displays a message that
  268.     the device driver can't proceed because of a breakpoint being
  269.     set near the top of the stack.
  270.  
  271.   3.6 Extensions to the built-in assembler in the CPU window
  272.   ----------------------------------------------------------
  273.  
  274.   Turbo Debugger supports all 80386 and 80387 instructions
  275.   mnemonics and registers:
  276.  
  277.     80386 Registers:
  278.  
  279.       EAX, EBX, ECX, EDX, ESI, EDI, EBP, ESP
  280.  
  281.     80386 Op Codes:
  282.  
  283.       BSF, BSR, BT, BTC, BTR, BTS, CDQ, CWDE, IRETD, LFS, LGS,
  284.       LSS, MOVSX, MOVZX, POPAD, POPFD, PUSHAD, PUSHFD, SETA,
  285.       SETB, SETBE, SETE, SETG, SETL, SETLE, SETNB, SETNE,
  286.       SETNL, SETNO, SETNP, SETNS SETO, SETP, SETS, SHLD, SHRD,
  287.       CMPSD, STOSD, LODSD, MOVSD, SCASD, INSD OUTSD, JECXZ
  288.  
  289.     80387 Op Codes:
  290.  
  291.       FCOS, FSIN, FPREM1, FSINCOS, FUCOM, FUCOMP, FUCOMPP
  292.  
  293.  
  294. 4. NOTES AND RESTRICTIONS
  295. -------------------------
  296.  
  297. o You need to set the files directive in your CONFIG.SYS file to
  298.   at least FILES = 10, preferably FILES = 20. If you have trouble
  299.   doing the File/OS Shell command or if TD can't find your source
  300.   modules, make sure the FILES directive is in your CONFIG.SYS.
  301.  
  302. o FNxxxx variants of floating-point instructions are not
  303.   supported in the built-in assembler in the CPU window.
  304.  
  305.   The Fxxxx instructions do not generate an FWAIT in Turbo
  306.   Debugger. You must manually code an FWAIT before floating-point
  307.   instructions if needed.
  308.  
  309. o A single Ctrl-Break when inside a DOS function call waiting for
  310.   console input will not interrupt DOS and return control to
  311.   Turbo Debugger. You can either press Ctrl-Break once and then
  312.   end the console input function by pressing Enter, or you can
  313.   press Ctrl-Break a second time.  You will then interrupt DOS and
  314.   Turbo Debugger will bring up a CPU Viewer showing code inside
  315.   DOS.  At this point, you can look around inside your program,
  316.   but you may not be able to use F7 or F8 to trace or step inside
  317.   DOS.  You should only use F9 at this point, after possibly
  318.   setting a breakpoint inside your program.
  319.  
  320. o TD386 uses INT FF to communicate with its protected-mode
  321.   supervisor. Therefore, you can't debug programs with TD386 that
  322.   use INT FF. If your program uses INT FF, change to using a
  323.   different interrupt (e.g., INT FE) while you are debugging your
  324.   program under TD386.
  325.  
  326.  
  327. 5.  MANUAL ADDITIONS AND CORRECTIONS
  328. ------------------------------------
  329.  
  330. Additions and corrections to the Turbo Debugger User's Guide that
  331. were made after it went to print are listed in MANUAL.DOC on the
  332. Turbo Debugger Help/Utilities Disk. We recommend that you read
  333. MANUAL.DOC and make the appropriate corrections in the Turbo
  334. Debugger User's Guide. You may use the README.COM utility supplied
  335. with Turbo Debugger to read this file by typing, for example,
  336.  
  337.   README MANUAL.DOC
  338.  
  339.  
  340. 6. FILES ON THE DISKS
  341. ---------------------
  342.  
  343.   TURBO DEBUGGER/INSTALLATION
  344.   ---------------------------
  345.   INSTALL  EXE  - Installs Turbo Debugger on your system
  346.   README   COM  - Program to display README file
  347.   TD       EXE  - Turbo Debugger Program
  348.   TD       OVL  - Turbo Debugger Program Overlay
  349.   HELPME!  DOC  - Text file with the answers to many common
  350.                   questions. Please read HELPME!.DOC before
  351.                   contacting Technical Support
  352.   README        - This file!
  353.  
  354.   HELP/UTILITIES
  355.   --------------
  356.   TDHELP   TDH  - Turbo Debugger Help File
  357.   TDINST   EXE  - Configuration Customization program
  358.   TDMAP    EXE  - Utility to extract debug information from .MAP
  359.                   files
  360.   TDUMP    EXE  - Utility to dump executable and object files
  361.   TDRF     EXE  - Remote file transfer utility
  362.   TDREMOTE EXE  - Remote debugging kernel
  363.   TD386    EXE  - Utility for 80386 virtual debugging
  364.   TDH386   SYS  - Device driver for TD386.EXE and the 80386 debug
  365.                   registers
  366.   TDSTRIP  EXE  - Utility to strip debug information off
  367.                   executable files
  368.   MANUAL   DOC  - Text file listing additions and corrections
  369.                   to the User's Guide
  370.  
  371.   UTILITIES/EXAMPLES
  372.   ------------------
  373.   TDCONVRT EXE  - Utility to convert CodeView information to Turbo
  374.                   Debugger information
  375.   TDPACK   EXE  - Utility to compress debug information
  376.   TDNMI    COM  - TSR to clear NMI every half second
  377.   UNPACK   COM  - Utility to unpack .ARC files
  378.   TDEXMPL  ARC  - Packed file that contains Turbo Debugger examples
  379.   TAEXMPL1 ARC  - Packed file that contains Turbo Assembler examples
  380.   TAEXMPL2 ARC  - Packed file that contains Turbo Assembler examples
  381.   CHAPXMPL ARC  - Packed file that contains Turbo Assembler examples
  382.